== How to Use Boutique ==

This document gives some advice to end users about how to use Boutique. You may
wish to copy and paste this information onto your server's website, but since
Boutique is reasonably configurable, it may not provide enough information. Feel 
free to edit the information contained in this document before pasting it, and
you needn't bother to list me as an author either. (The plugin is released under
a rather strict license because I can't be bothered to research different
licenses, so I feel obligated to say that last sentence.)

The document is organised into talking about useful commands for everyone, for
buyers, and then sellers. It must not be thought that "buyer" and "seller" are
classes that are picked by players, it is simply a way to explain how to use the
plugin.
The next section talks about admins, and the final section lists the commands

=== Everyone ===
Use /shop commands to get a list of commands for the plugin

---------------------


 -----------------------

=== Buyers ===
There are four useful commands:

      /shop list
      /shop go [user]

/shop list gives you a list of shops, and a description of each of these shops.
In some configurations, and/or if the list is heavily populated, the description
will be omitted.

/shop go [user] may allow you to teleport to the shop belonging to [user],
depending whether you are permitted to by the server's admin. This command may
instead send a request to the owner of the shop, and they will decide whether
you are allowed to teleport there. You will be teleported there if they decide
to accecpt your request. 

=== Sellers ===
There are as many as ten useful commands:

      /shop create
      /shop open
      /shop close
      /shop
      /shop edit location
      /shop edit description
      /shop edit reset
      /shop delete
      /shop accept
      /shop deny.

If you have been allowed to, you can create a shop using 
/shop create [description]. You may have only one shop at a time, and each time
you use /shop create, your previous shop's details will be overwritten.
[description] may be optional, required or forbbiden by your admin. When your
shop is created with /shop create, your shop will be set automatically to
"closed".

Your shop can be opened and closed using /shop open and /shop close as long as
you have been granted permission to do so. Depending on the configuration on
your server, whether your shop is open or closed affects whether you appear in
the /shop list, or whether and how people can teleport to your shop.

/shop may allow you to teleport to your own shop, depending on the whether you
are premitted to do so

'/shop edit' is used to edit your shop. '/shop edit location' will change only
the teleport destination of your shop, whilst
'/shop edit description [description]' will change only the description.
'/shop edit reset [description]' will change both of these things

/shop delete will delete your shop permenantly. It is possible for this option
to be disabled - you may have to ask an admin to delete it for you.

Finally, /shop accept and /shop deny are the commands used to accept or deny a 
teleport request to your shop. You will only need to use these when a message
appears on-screen informing you of the choice. On some configurations, these
commands will never need to be used because request teleporting may not be
set up by the admin.

===  Admins ===
Admins, as of 2.0, have special permissions. This allows them to teleport to
anyone's shop at any time, and also to delete shops. This is depend on whether
admins have been granted this permission.

you can list admins commands with /shop admin, though the only command currently
available is /shop admin delete [player], which deletes [player]'s shop.

=== Commands ===

/shop list
 - Displays a list of shops
/shop go [username]
 - telelport to [username]'s shop
/shop create [description]
 - register a shop with a [description], or update your shop
/shop open
 - open your shop
/shop close
 - close your shop (details are kept so that you may open it again at any time)
/shop
 - teleport to your shop
/shop edit location
 - change the teleport location of your shop
/shop edit description [description]
 - change the description of your shop
/shop edit reset [description]
 - change the description and location of your shop
/shop delete
 - delete your shop
/shop accept
 - accept a request for a user to teleport to your shop
/shop deny
 - deny a request for a user to teleport to your shop
/shop commands
 - display a list of commands
/shop admin delete [player]
 - deletes [player]'s shop

== Command Aliases ==

I'm not yet sure how an alias for /shop works, but it's in my todo list. An
alias is set in my plugin's plugin.yml, but don't quite know how best to
implement this, or even if I have to.

What follows is a list of aliases for the above commands:
/shop create:
  /shop make
  /shop register
/shop go:
  /shop goto
  /shop tp
/shop commands
  /shop command
  /shop help
  /shop ?

I'll add more in the next update so that you can do stuff like '/shop o' to to open your shop


